Skip to content

fix stream/message buffer type and timeout in example#1404

Merged
kstribrnAmzn merged 1 commit intoFreeRTOS:mainfrom
Isla-jq:fix/Correct-type-and-timeout-in-example
Apr 21, 2026
Merged

fix stream/message buffer type and timeout in example#1404
kstribrnAmzn merged 1 commit intoFreeRTOS:mainfrom
Isla-jq:fix/Correct-type-and-timeout-in-example

Conversation

@Isla-jq
Copy link
Copy Markdown
Contributor

@Isla-jq Isla-jq commented Apr 18, 2026

fix stream/message buffer type and timeout in example

Description

Changed MessageBuffer_t to MessageBufferHandle_t in two function examples.
Changed StreamBuffer_t to StreamBufferHandle_t in two function examples.
The examples incorrectly reference  MessageBuffer_t  and  StreamBuffer_t , but the public API only exposes  MessageBufferHandle_t  and  StreamBufferHandle_t  (which are typedefs for pointers to those structs).
Both comments describing a 100ms timeout don't match the actual code pdMS_TO_TICKS(20). The comments have been updated to accurately state 20ms.

Test Steps

  • The sample code compiles and runs without issues. The corrected examples now work correctly.
  • Verified that both the pdMS_TO_TICKS(20) value matches the updated 20ms description.

Checklist:

  • I have tested my changes. No regression in existing tests.
  • I have modified and/or added unit-tests to cover the code changes in this Pull Request.

Related Issue

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@sonarqubecloud
Copy link
Copy Markdown

@kstribrnAmzn
Copy link
Copy Markdown
Member

Thank you for the contribution! LGTM :)

@kstribrnAmzn kstribrnAmzn merged commit 5f2cc25 into FreeRTOS:main Apr 21, 2026
21 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants